-
Notifications
You must be signed in to change notification settings - Fork 44
feat: introduce automated tag and release process in maintainer guide #280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
1. **Checkout the merge commit:** | ||
|
||
```bash | ||
git checkout MERGE_COMMIT_ID |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does this handle multiple unreleased modules if they are merged through multiple commits but haven't been released in a while?
I guess if we checkout the most latest merge commit the script will see all modules available (even the ones merged previously but unreleased) and tag them all at the currently checked out module.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there are previous commits that have not been released before he current commit, it would include them in the release process.
I originally thought that this might be a problem, but figured that it might ensure that we never have forgotten unreleased modules if we use this script often.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess if we wrote this into a workflow we could essentially detect it on every commit and automatically release it if I wrote in a way to suppress the confirmation message
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
: 🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces an automated tag and release process for maintainers by adding detailed documentation to the MAINTAINER.md file and relocating the tag_release.sh script to a scripts directory. The changes streamline the release workflow by providing maintainers with a comprehensive guide for using the automated tagging system.
- Added detailed documentation for the automated tag and release process with prerequisites, steps, and example output
- Reorganized the release section to prioritize the automated approach while keeping manual process as fallback
- Moved tag_release.sh script to /scripts directory for better organization
2. **Run the tag release script:** | ||
|
||
```bash | ||
./scripts/tag_release.sh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation references ./scripts/tag_release.sh
but there's no indication in this PR that the script was actually moved to the scripts directory. Consider verifying the script location or updating the path if the move hasn't occurred yet.
./scripts/tag_release.sh | |
./tag_release.sh |
Copilot uses AI. Check for mistakes.
Description
Add the new automated Release process to MAINTAINER.md, and moved the tag_release.sh script to /scripts
Type of Change
Testing & Validation
bun test
)bun run fmt
)Related Issues
None